Add load tests #453

alexeyr-ci · 2024-11-10T19:10:01Z

Summary by CodeRabbit

Release Notes

New Features
- Introduced performance testing scripts for HTTP requests using the k6 framework.
- Added support for dynamic delay parameters in streaming components, enhancing flexibility in response handling.
- New utility functions for managing environment variables and configuring k6 testing options.
- Added a new Bash script to facilitate starting the application in a production environment using Overmind.
- New section on Benchmarking in the contribution guidelines.
Bug Fixes
- Improved validation checks for HTTP responses in performance tests.
Documentation
- Updated ESLint configuration for better TypeScript handling and K6 integration.
- Enhanced contributor guidelines with updated debugging instructions and benchmarking recommendations.
Chores
- Added a new development dependency for k6 type definitions.

coderabbitai · 2024-11-10T19:10:07Z

Walkthrough

The changes introduce several updates related to performance testing using the k6 framework. New utility functions are created to manage environment variables and configuration options. Performance testing scripts are added to validate HTTP responses, while existing components are modified to accept dynamic delay parameters. The ESLint configuration is updated to accommodate new global variables and stricter rules for k6 files. Additionally, a new development dependency is added to the package configuration.

Changes

File	Change Summary
`k6/root.js`	Introduced a performance testing script with HTTP GET request and response validation.
`k6/streaming.js`	Added an asynchronous function for testing streaming components with dynamic delay handling.
`package.json`	Added new development dependency: `"@types/k6": "^0.54.2"`.
`spec/dummy/app/views/pages/stream_async_components.html.erb`	Modified rendering logic to handle dynamic delay parameter for `StreamAsyncComponents`.
`spec/dummy/client/app/ror-auto-load-components/StreamAsyncComponents.jsx`	Updated asynchronous functions to accept `delayMs` parameter for flexible delay handling.
`.eslintrc`	Updated global variable mutability and added new overrides for k6 files with stricter rules.
`k6/lib/util.js`	Introduced utility functions for URL construction and dynamic K6 options configuration.
`CONTRIBUTING.md`	Added a new section on Benchmarking and updated the Debugging section to use Overmind.
`spec/dummy/bin/prod`	Created a new Bash script for setting environment variables and starting the application in production.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant K6
    participant Server

    User->>K6: Start Performance Test
    K6->>Server: GET Request to Root URL
    Server-->>K6: Response (Status 200, Body "Hello WORLD!")
    K6->>User: Validation Check Passed

sequenceDiagram
    participant User
    participant K6
    participant Server

    User->>K6: Start Streaming Test
    K6->>Server: GET Request to Streaming URL with Delay
    Server-->>K6: Response (Status 200, Comments)
    K6->>User: Validation Check Passed

🐰 "In the fields where the rabbits play,
New scripts and tests brighten the day.
With delays now set, oh what a treat,
Performance testing can't be beat!
Hops of joy, let’s celebrate,
For changes here, we can’t wait!" 🐇

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between ffc20a0 and 72f5115.

📒 Files selected for processing (6)

.eslintrc (1 hunks)
CONTRIBUTING.md (1 hunks)
k6/lib/util.js (1 hunks)
k6/root.js (1 hunks)
k6/streaming.js (1 hunks)
spec/dummy/bin/prod (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (3)

spec/dummy/bin/prod
k6/root.js
k6/streaming.js

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

AbanoubGhadban · 2024-11-17T12:26:57Z

k6/root.js

+  const rootUrl = url('');
+  check(http.get(rootUrl), {
+    'status was 200': (res) => res.status === 200,
+    'includes expected text': (res) => res.body?.toString()?.includes('Hello WORLD!'),


Can you add more checks from other components? So we can make sure all components are rendered under load testing.

AbanoubGhadban

LGTM 🔥

alexeyr-ci · 2024-11-17T14:20:14Z

.eslintrc

-globals:
-  __DEBUG_SERVER_ERRORS__: true
-  __SERVER_ERRORS__: true


alexeyr-ci force-pushed the alexeyr/benchmark branch 5 times, most recently from 2f3578b to a2b11e8 Compare November 11, 2024 15:04

AbanoubGhadban reviewed Nov 17, 2024

View reviewed changes

AbanoubGhadban approved these changes Nov 17, 2024

View reviewed changes

alexeyr-ci force-pushed the alexeyr/benchmark branch 2 times, most recently from 2afaeec to 93c38ef Compare November 17, 2024 14:19

alexeyr-ci commented Nov 17, 2024

View reviewed changes

.eslintrc

Comment on lines -10 to -12

globals:

__DEBUG_SERVER_ERRORS__: true

__SERVER_ERRORS__: true

Copy link

Contributor Author

alexeyr-ci Nov 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not used.

alexeyr-ci force-pushed the alexeyr/benchmark branch 6 times, most recently from 74165f4 to ff89b48 Compare November 18, 2024 19:23

alexeyr-ci mentioned this pull request Nov 19, 2024

Add load tests to CI #458

Open

4 tasks

alexeyr-ci force-pushed the alexeyr/benchmark branch from ff89b48 to bd44988 Compare November 19, 2024 08:41

alexeyr-ci mentioned this pull request Nov 21, 2024

Create load tests and add them to CI shakacode/react_on_rails#1658

Open

alexeyr-ci force-pushed the alexeyr/benchmark branch 2 times, most recently from 8cb4f79 to 7e81a58 Compare November 21, 2024 14:55

alexeyr added 2 commits January 5, 2025 12:58

Initial k6 load test

5fb9faa

Add streaming load test using k6

441a8d7

alexeyr-ci force-pushed the alexeyr/benchmark branch from 7e81a58 to ffc20a0 Compare January 5, 2025 13:00

alexeyr added 5 commits January 5, 2025 13:01

Fix ESLint for K6

573cd19

Switch the streaming load test from browser to request API

47f60cd

Move _util to lib/

fc4ed67

Format k6/**

48c639a

Update check for rendered components

d48e6fe

alexeyr added 5 commits January 5, 2025 13:01

Improve defaultOptions

6b11238

Add benchmarking to docs

84a5e20

Switch streaming back to browser tests

b59fd67

Add spec/dummy/bin/prod

a25cc54

Add thresholds for failing test

72f5115

alexeyr-ci force-pushed the alexeyr/benchmark branch from ffc20a0 to 72f5115 Compare January 5, 2025 13:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add load tests #453

Add load tests #453

Uh oh!

alexeyr-ci commented Nov 10, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Nov 10, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

AbanoubGhadban Nov 17, 2024

Uh oh!

AbanoubGhadban left a comment

Uh oh!

alexeyr-ci Nov 17, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Add load tests #453

Are you sure you want to change the base?

Add load tests #453

Uh oh!

Conversation

alexeyr-ci commented Nov 10, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Release Notes

Uh oh!

coderabbitai bot commented Nov 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

AbanoubGhadban Nov 17, 2024

Choose a reason for hiding this comment

Uh oh!

AbanoubGhadban left a comment

Choose a reason for hiding this comment

Uh oh!

alexeyr-ci Nov 17, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

alexeyr-ci commented Nov 10, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 10, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)